Filter hook 'set_screen_option_{$option}'

in WP Core File wp-admin/includes/misc.php at line 792

Description

Filters a screen option value before it is set. The dynamic portion of the hook name, `$option`, refers to the option name. Returning false from the filter will skip saving the current option.

Occurrences

Filename Line Number
wp-admin/includes/misc.php 792

Parameters

Type Name Description
mixed $screen_option The value to save instead of the option value. Default false (to skip saving the current option).
string $option The option name.
int $value The option value.

PHP Doc

/**
			 * Filters a screen option value before it is set.
			 *
			 * The dynamic portion of the hook name, `$option`, refers to the option name.
			 *
			 * Returning false from the filter will skip saving the current option.
			 *
			 * @since 5.4.2
			 *
			 * @see set_screen_options()
			 *
			 * @param mixed   $screen_option The value to save instead of the option value.
			 *                               Default false (to skip saving the current option).
			 * @param string  $option        The option name.
			 * @param int     $value         The option value.
			 */